Skip to content

Updates for ease of newcomers #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Changes from 5 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
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
# Pulsar Edit

This is the website repo for Pulsar Edit. It contains our documenation and other information users might be looking for. Visit the [Website](https://pulsar-edit.github.io).
This is the website repo for Pulsar Edit. It contains our documentation and other information users might be looking for. Visit the [Website](https://pulsar-edit.github.io).


## Guide

### Recommended Tools:
- [Toolbox](https://containertoolbx.org/): We recommend using this tool to aide in development as it helps with containerization.
- On Linux, Toolbox should be available to install via your native package manager. Alternatively, Toolbox can also be installed by utilizing [Brew](https://brew.sh/).
- On MacOS, Brew is also available. However, if Brew is not an option we recommend downloading Toolbox directly from the [official website](https://containertoolbx.org/).
- Yarn (don't set this up just yet, follow the guide below)

### Setup
- Clone the repo! You can do this by using the following command:
`git clone https://github.com/pulsar-edit/pulsar-edit.github.io.git pulsar-site`
This will create a folder called `pulsar-site` at the current location of your terminal
- Once you've installed Toolbox, create a toolbox container using the following command `toolbox create pulsar-site` where `pulsar-site` is the container's name.
- After the container has been built, you can begin using it by entering `toolbox enter pulsar-site` into your terminal. If you used a different name when creating the container, substitute `pulsar-site` with that name.
-