Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 63 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,69 @@
# render50

## Usage
`render50` is a command-line tool from CS50 that renders and previews code or text files in a standardized, user-friendly format.

---

## Installation

Install via `pip`:

```bash
pip3 install render50
```
pip3 install cli50
cli50

Or install locally from source:

```bash
git clone https://github.com/cs50/render50
cd render50
pip3 install -e .
./render50
```

---

## Usage

```bash
render50 [options] file [file ...]
```

### Example

```bash
render50 example.txt
```

Replace `example.txt` with the path to your file. Multiple files may be passed as arguments.

---

## Requirements

* Python 3.x
* Dependencies listed in `requirements.txt`

---

## Documentation

Full documentation is available at:

[https://cs50.readthedocs.io/render50/](https://cs50.readthedocs.io/render50/)

---

## Contributing

Contributions are welcome. Feel free to:

* Open issues
* Submit pull requests
* Propose new features

---

## License

This project is licensed under the GPL-3.0 License.