Skip to content

armgit / memos

Public Imported from GitHub
0

Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.

chore: update docs

Stevena0a42285d01b
diff --git a/README.md b/README.md
index ebf6f374d..dc9393308 100644
--- a/README.md
+++ b/README.md
@@ -36,53 +36,14 @@ Memos should be running at [http://localhost:5230](http://localhost:5230). If th
### Docker Compose
-See [the example `docker-compose.yaml`](./docker-compose.yaml) file.
+See more in the example [`docker-compose.yaml`](./docker-compose.yaml) file.
-## Development
-
-Memos is built with a curated tech stack. It is optimized for developer experience and is very easy to start working on the code:
-
-1. It has no external dependency.
-2. It requires zero config.
-3. 1 command to start backend and 1 command to start frontend, both with live reload support.
-
-### Tech Stack
-
-<img alt="tech stack" src="https://raw.githubusercontent.com/usememos/memos/main/resources/tech-stack.png" width="360" />
-
-### Prerequisites
-
-- [Go](https://golang.org/doc/install)
-- [Air](https://github.com/cosmtrek/air#installation) for backend live reload
-- [Node.js](https://nodejs.org/)
-- [yarn](https://yarnpkg.com/getting-started/install)
-
-### Steps
-
-1. pull source code
-
- ```bash
- git clone https://github.com/usememos/memos
- ```
-
-2. start backend using air(with live reload)
-
- ```bash
- air -c scripts/.air.toml
- ```
-
-3. start frontend dev server
-
- ```bash
- cd web && yarn && yarn dev
- ```
-
-Memos should now be running at [http://localhost:3000](http://localhost:3000) and change either frontend or backend code would trigger live reload.
-
-### Contributing
+## 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. 🥰
+Gets more about [development guide](https://github.com/usememos/memos/tree/main/docs/development.md).
+
## Star history
[![Star History Chart](https://api.star-history.com/svg?repos=usememos/memos&type=Date)](https://star-history.com/#usememos/memos&Date)
diff --git a/docs/development.md b/docs/development.md
new file mode 100644
index 000000000..58e82ba4b
--- /dev/null
+++ b/docs/development.md
@@ -0,0 +1,40 @@
+# Development
+
+Memos is built with a curated tech stack. It is optimized for developer experience and is very easy to start working on the code:
+
+1. It has no external dependency.
+2. It requires zero config.
+3. 1 command to start backend and 1 command to start frontend, both with live reload support.
+
+## Tech Stack
+
+![tech-stack](https://raw.githubusercontent.com/usememos/memos/main/resources/tech-stack.png)
+
+## Prerequisites
+
+- [Go](https://golang.org/doc/install)
+- [Air](https://github.com/cosmtrek/air#installation) for backend live reload
+- [Node.js](https://nodejs.org/)
+- [yarn](https://yarnpkg.com/getting-started/install)
+
+## Steps
+
+1. pull source code
+
+ ```bash
+ git clone https://github.com/usememos/memos
+ ```
+
+2. start backend using air(with live reload)
+
+ ```bash
+ air -c scripts/.air.toml
+ ```
+
+3. start frontend dev server
+
+ ```bash
+ cd web && yarn && yarn dev
+ ```
+
+Memos should now be running at [http://localhost:3000](http://localhost:3000) and change either frontend or backend code would trigger live reload.