Skip to content
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

Updates for ease of newcomers #13

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
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
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
# 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

### Dependencies we use:

- Vuepress@next
- pnpm
-

### Recommended Tools:
kaosine marked this conversation as resolved.
Show resolved Hide resolved

### Setup
kaosine marked this conversation as resolved.
Show resolved Hide resolved

- 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.
- 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).

## Development

Expand Down
Loading