-
-
Notifications
You must be signed in to change notification settings - Fork 38
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
kaosine
wants to merge
7
commits into
main
Choose a base branch
from
readme-setup
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f1d3cca
Updates for ease of newcomers
kaosine c053de6
Typo Fixes
kaosine 6596470
Fix misspelling
Spiker985 25f0c69
Verbiage Change
Spiker985 b5af292
Apply suggestions from code review
kaosine 4429024
Merge branch 'main' into readme-setup
kaosine f0c4b7b
removing toolbox in prep for vagrant
kaosine File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/). | ||
kaosine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- 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/). | ||
kaosine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Yarn (don't set this up just yet, follow the guide below) | ||
|
||
### 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. | ||
- |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.