Update readme

This commit is contained in:
Rodrigo Pinto 2024-12-05 18:30:28 -03:00
commit 6a4fbf5afc

View file

@ -18,49 +18,7 @@ The project intends to be a demonstration of how to use [Tahoe-lafs]() "provide
git clone https://github.com/blaisep/private_facts.git && cd private_facts git clone https://github.com/blaisep/private_facts.git && cd private_facts
``` ```
### Install from (Docker) Image Install dependencies.
TBA
###
```bash
a bash code block
```
### SvelteKit
Requirements
- NodeJs > 20.0
- Pnpm
Install dependencies and run:
```sh
cd packages
pnpm install
pnpm dev --open
```
## Usage
### Run using a (OCI) container
```python
A Python code block
```
## Feedback
The project issue tracker is getting migrated. For now, feel free to open an issue and let us know how how to improve.
## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
### Install dependencies
```sh ```sh
uv venv uv venv
@ -68,8 +26,6 @@ source .venv/bin/activate
uv pip install -r pyproject.toml uv pip install -r pyproject.toml
``` ```
### Set up developer environment
Setup a grid: Setup a grid:
```sh ```sh
@ -122,6 +78,48 @@ Client:
.venv/bin/tahoe -d webapp run .venv/bin/tahoe -d webapp run
``` ```
### Install from (Docker) Image
TBA
###
```bash
a bash code block
```
### SvelteKit
Requirements
- NodeJs > 20.0
- Pnpm
Install dependencies and run:
```sh
cd packages
pnpm install
pnpm dev --open
```
## Usage
### Run using a (OCI) container
```python
A Python code block
```
## Feedback
The project issue tracker is getting migrated. For now, feel free to open an issue and let us know how how to improve.
## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
### Getting ready for your first pull request ### Getting ready for your first pull request
Please make sure to update tests as appropriate. Please make sure to update tests as appropriate.