Musselman/notatio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

📝 Docs: Add Code of Conduct and Contribution Guide

Browse source 
Just a basic version, will edit as needed.
This commit is contained in:
James Musselman 2024-06-29 23:39:23 -05:00
parent ff5f340d8c
commit b7895e0132
Signed by: Musselman
GPG key ID: 1DAEFF35ECB5D6DB
3 changed files with 195 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -2,34 +2,35 @@
## 💡 About
**Notatio is currently under heavy development, and as such there is the possibility breaking changes**
**Notatio is currently under heavy development!
As such there is the possibility breaking changes**
Notatio is a self-hostable, containerized, web-based text editor. The main objective of the project is to create a platform independent text editor (and productivity management suite). I hope to develop this as an alternative to proprietary software like obsidian and Notion.so which I have loved and used in the past. This software was originally created as part of a Senior Capstone, but is now being developed in my spare time while job hunting.
Notatio is a self-hostable, containerized, web-based text editor.
The main objective of the project is to create a platform independent text editor (and productivity management suite).
I hope to develop this as an alternative to proprietary software like obsidian and Notion.so which I have loved and used in the past.
This software was originally created as part of a Senior Capstone, but is now being developed in my spare time while job hunting.
## 🛣️ **Roadmap**
#### In Progress
### In Progress
- 🕓 Building Custom Text Editor
- 🕓 Add Kanban Board
#### Planned V1 Release
### Planned V1 Release
- [ ] Flesh out File Management Operations
- [ ] NoSQL setup option
#### Planned v1.1 Release
### Planned v1.1 Release
- [ ] Collaborative Editing
- [ ] File Versioning
#### Planned v1.2 Release
### Planned v1.2 Release
- [ ] End-to-End Encryption
## 💾 **Download**
Downloading Notatio is simple! Just clone the repository using the command below:
@ -42,7 +43,7 @@ git clone https://codeberg.org/musselman/notatio
There are two ways to run Notatio.
### 📦 Container (Recommended)**
### 📦 Container (Recommended)\*\*
---
@ -98,4 +99,4 @@ As this is no longer an academic project, All contributions are welcome. Please
## 📄 License
This project is licensed under the AGPL - see the [LICENSE](./LICENSE) file for details
This project is licensed under the AGPL – see the [LICENSE](./LICENSE) file for details