Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
RaphGL committed Apr 17, 2022
1 parent 7acb30d commit 7706280
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@

Neosent is a drop-in replacement for Suckless Sent. It reimplements all of the features but instead of depending on X to output presentations it outputs presentations directly to PDF with the goal of making them more portable.


### Built With

- [Python](https://www.python.org/)
Expand All @@ -64,11 +63,27 @@ TODO

NeoSent files usually have a `.ns` extension, but any (or no) extension is allowed as well.

To compile your pdf, simply do:
To get your PDF, run:

```sh
$ neosent file.ns
```

All defaults can be changed through the use of flags.
Example:

```sh
$ neosent --set-res 1280 720 \
--set-bg 40 42 54 \
--set-fg 248 248 242 \
--set-font "~/.fonts/FreeSans.ttf" \
--set-font-size 24 \
-o "Final Presentation.pdf" \
final_presentation.ns
```

To learn more about the flags available, check `neosent --help`.

The syntax is very minimal, to learn it just see this example:

```
Expand All @@ -80,7 +95,7 @@ It depends on:
- Python
- Pillow
neosent [FILE]
neosent [FILE]
one slide per paragraph
# This is a comment and it won't appear in the presentation
Expand All @@ -91,7 +106,6 @@ one slide per paragraph
Having problemas? Make an issue!
```


<!-- LICENSE -->

## License
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ def read(fname):
include_package_data=True,
package_data={
'': ['data/*']
},
},
)

0 comments on commit 7706280

Please sign in to comment.