Skip to content

Latest commit

 

History

History
181 lines (130 loc) · 6.32 KB

README.md

File metadata and controls

181 lines (130 loc) · 6.32 KB
Raw

Contributors Forks Stargazers Issues GPL v2


Logo

Make project documentations easily

Designed with hardware documentation in mind
Download the app »

Project website ·

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

hardocs-gif-screen-shot

There are already many good solutions to document projects on the cloud, but we wanted to develop a solution that is local first and offline first, allows you easily generate documents within folders and projects and work easily with images.

Why to use it

  • Prepare your project documentation as a set of documents that relate with each other.
  • Create html documents in a simple and straightforward way.
  • Edit tables easily.
  • Work with text images intuitively, what you see is what you get.

Built With

Hardocs is a hybrid desktop application that uses web technologies done in javascript.

Getting Started

Installation

Building the app on your local environment

✋ Make sure to have npm or yarn installed globally. For this project we use yarn, if you want to contribute we would appreciate if you stick to yarn 😸.

  • Clone this repository.
  • Run yarn install or npm install.
  • Building for development: run yarn electron:serve or npm run electron:serve.
  • Building for production: Once the application is installed, run yarn e-build or npm .

Roadmap

See the open issues for a list of proposed features (and known issues).

  • Metadata reader and editor.
  • Selection of metadata standards specified in JSON schemas.
  • Pandoc integration to import and export different document formats (pdfs, epubs, markdown, etc.).
  • Local database listing users project.
  • Cloud database to collaborate and share your documents databases.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Download the app and give it a try.
  2. Take our usability survey to get your feedback.
  3. Read our extended contribution guidelines

License

Distributed under the GPLv2.0 License. See LICENSE for more information.

Contact

Jose Carlos Urra Llanusa - @jurra - [email protected]

Acknowledgements