diff --git a/readme.md b/readme.md index 8ea98e8c6..01c057d94 100644 --- a/readme.md +++ b/readme.md @@ -1,46 +1,88 @@ -> # New Boost Note app is available! -> -> We've launched a new Boost Note app which supports real-time collaborative writing. -> -> And it is open sourced too! Please check it out! https://github.com/BoostIO/BoostNote-App -> -> ## 📦 Download App -> -> ### 🖥 Desktop -> -> - [🌎 Web App (boostnote.io)](https://boostnote.io) -> - [🍎 macOS (.dmg)](https://github.com/BoostIO/BoostNote-App/releases/latest/download/boost-note-mac.dmg) -> - [:framed_picture: Windows (.exe NSIS)](https://github.com/BoostIO/BoostNote-App/releases/latest/download/boost-note-win.exe) -> - [🐧 Linux (.deb)](https://github.com/BoostIO/BoostNote-App/releases/latest/download/boost-note-linux.deb) -> - [🐧 Linux (.rpm)](https://github.com/BoostIO/BoostNote-App/releases/latest/download/boost-note-linux.rpm) -> -> ### 📱 Mobile -> -> - [🌎 Mobile Web App (m.boostnote.io)](https://m.boostnote.io) -> - [🍏 iOS (Apple App Store)](https://apps.apple.com/gb/app/boost-note-mobile/id1576176505) -> - [🤖 Android (Google Play Store)](https://play.google.com/store/apps/details?id=com.boostio.boostnote2021) - -

BoostNote-Legacy

- -

Note-taking app for programmers.

-
Apps available for Mac, Windows and Linux.
-
Built with Electron, React + Redux, Webpack, and CSSModules.
-

- - Build Status - -

- -## Download - -[Find the latest release of Boostnote here!](https://github.com/BoostIO/boost-releases/releases/) - -#### More Information - -- Website: https://boostnote.io -- [Development](https://github.com/BoostIO/Boostnote/blob/master/docs/build.md): Development configurations for Boostnote. -- Copyright (C) 2016 - 2020 BoostIO, Inc. - -#### License - -[GPL v3](./LICENSE). + +# BoostNote Legacy + +Boost note is an open-source application that allows developers to take notes and manage code snippets. This cross-platform app will increase your productivity and make organizing notes and code way easier! Give it a try! + + +## Features +Some of the best features of this app include: + +- **Code Snippet Management**: Store and manage your code in an easy to view way. +- **Cross-Platform**: Runs on three different platforms: Windows, macOS, and Linux. +- **Offline Mode**: No internet is needed to use the application. +- **Customizable**: You can choose different themes and personalize your workspace. + +## Installation + +Before we begin, you need the following **System Requirements** : + + +- **Node.js**: v10 or higher +- **npm**: v6 or higher + +### Installation Instructions + +#### Windows +1. Download the installer at this link https://github.com/BoostIO/BoostNote-Legacy/releases. +2. Once downloaded, run the installer and follow the steps prompted. + +#### macOS +1. Download the(https://github.com/BoostIO/BoostNote-Legacy/releases. +2. Openfile and drage BoostNote to your Applications (follow prompted steps). + +#### Linux +1. Download `.AppImage` file fromhttps://github.com/BoostIO/BoostNote-Legacy/releases. +2. Run the file using your package manager or execute the `.AppImage`. + +#### From Source (for developers) +1. Clone the repository: + ```bash + git clone https://github.com/BoostIO/BoostNote-Legacy.git + cd BoostNote-Legacy + ``` +2. Install dependencies: + ```bash + npm install + ``` +3. Run the application: + ```bash + npm start + ``` + +## Version History + +Check the latest releases via this page: https://github.com/BoostIO/BoostNote-Legacy/releases. + + +## Getting Started + +If you're new to BoostNote, follow these steps: + +1. Use the [Installation](#installation) instructions for your platform. +2. Open the app, click on "New Note," and start writing! +3. Use folders and tags to structure your notes. +4. Connect to the cloud for further organization. + +Visit the [BoostNote Documentation](https://boostnote.io/docs) for more information and help regarding BoostNote.Io! + +## How to Contribute + +We welcome contributions from the community! To get started: + +1. Fork the repository and clone it locally. +2. Create a new branch for your feature or bug fix: + ```bash + git checkout -b feature-name + ``` +3. Make your changes, following the format in this link: (https://github.com/BoostIO/BoostNote-Legacy/blob/master/CONTRIBUTING.md). +4. Submit a pull request. + + +## License + +BoostNote is licensed under the [MIT License](https://github.com/BoostIO/BoostNote-Legacy/blob/master/LICENSE). + +### Last but certainly not least... + +Have fun and keep coding! +