updated instructions

This commit is contained in:
tcsenpai 2024-11-17 20:07:27 +01:00
parent 86dcd79923
commit e9e83306c1

View File

@ -26,15 +26,17 @@ This project draws heavily from two other projects: one called [Rewind](https://
## Quick Start
### MacOS & Windows
![memos-installation](docs/images/memos-installation.gif)
### 1. Install Pensieve
#### 1. Install Pensieve
```sh
pip install memos
```
### 2. Initialize
#### 2. Initialize
Initialize the pensieve configuration file and sqlite database:
@ -44,7 +46,7 @@ memos init
Data will be stored in the `~/.memos` directory.
### 3. Start the Service
#### 3. Start the Service
```sh
memos enable
@ -57,6 +59,32 @@ This command will:
- Start the Web service
- Set the service to start on boot
### Linux
**Note:** Linux support is still under development. At the moment, you can run the app by following the steps below.
**Important:** You need to have `conda` installed to run the app. Also, if something is not working, check the single commands in the shell files to see if they are working.
- [x] Tested on Ubuntu 22.04 + KDE Plasma + Wayland
#### 1. Install Dependencies
```sh
./linuxdeps.sh
```
#### 2. Install Pensieve
```sh
./local_setup.sh
```
#### 3. Start the App
```sh
source start.sh
```
### 4. Access the Web Interface
Open your browser and visit `http://localhost:8839`