Update README.md
This commit is contained in:
@@ -15,26 +15,24 @@ Each Markdown file will contain:
|
|||||||
|
|
||||||
Most of these values will be in the form of `key:: value` for easy integration with Obsidian's plugin Dataview. A sample script is available [here](./dataview-query.js)
|
Most of these values will be in the form of `key:: value` for easy integration with Obsidian's plugin Dataview. A sample script is available [here](./dataview-query.js)
|
||||||
|
|
||||||
## Setup & Run
|
## Build & Run
|
||||||
|
|
||||||
|
### Pre-requirements
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Required by the httprequest dependency
|
||||||
|
$ sudo apt install libcurl4-openssl-dev
|
||||||
|
```
|
||||||
|
|
||||||
|
- Clone this repository
|
||||||
|
- Install Janet and jpm https://janet-lang.org/
|
||||||
- Get an access token for your Mastodon account
|
- Get an access token for your Mastodon account
|
||||||
|
|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
- Run the program
|
|
||||||
|
|
||||||
```sh
|
### Run
|
||||||
# Will download bookmarks and attachments in ./bookmarks
|
|
||||||
$ ./mastodon-bookmarks YOUR_INSTANCE YOUR_APP_TOKEN
|
|
||||||
```
|
|
||||||
|
|
||||||
The `YOUR_INSTANCE` value **must not** have the trailing slash (e.g: `https://hachyderm.io`)
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
- Clone this repository
|
|
||||||
- Install Janet and jpm https://janet-lang.org/
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Install dependencies locally with -l (--local)
|
# Install dependencies locally with -l (--local)
|
||||||
@@ -43,7 +41,9 @@ $ jpm deps -l
|
|||||||
$ jpm -l janet main.janet YOUR_INSTANCE YOUR_APP_TOKEN
|
$ jpm -l janet main.janet YOUR_INSTANCE YOUR_APP_TOKEN
|
||||||
```
|
```
|
||||||
|
|
||||||
## Build binary
|
The `YOUR_INSTANCE` value **must not** have the trailing slash (e.g: `https://hachyderm.io`)
|
||||||
|
|
||||||
|
### Build for release
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ jpm build -l
|
$ jpm build -l
|
||||||
|
|||||||
Reference in New Issue
Block a user