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.

Sign up for GitHub

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

Updates for ease of newcomers #13

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f1d3cca
Updates for ease of newcomers
kaosine Sep 15, 2022
c053de6
Typo Fixes
kaosine Sep 15, 2022
6596470
Fix misspelling
Spiker985 Sep 16, 2022
25f0c69
Verbiage Change
Spiker985 Sep 16, 2022
b5af292
Apply suggestions from code review
kaosine Sep 18, 2022
4429024
Merge branch 'main' into readme-setup
kaosine Sep 29, 2022
f0c4b7b
removing toolbox in prep for vagrant
kaosine Oct 1, 2022
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# 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).
Spiker985 marked this conversation as resolved.
Show resolved Hide resolved


## Guide

### Tools Needed:
Spiker985 marked this conversation as resolved.
Show resolved Hide resolved
- Toolbox: We recommend using this as a development tool. It helps with containerization of development.
kaosine marked this conversation as resolved.
Show resolved Hide resolved
- This can be setup in most distributions of linux using your package manager or with brew. Brew can also be used on Mac but if that's not ideal we recommend getting directly from the [official website](https://containertoolbx.org/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe once we have more details we could go ahead and make each OS it's own bullet point, like so:

- Toolbox: We recommend using this as a development tool. It helps with containerization of the development process.
  - Linux: ...
  - Mac: ...
  - Windows: ...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean, there's also Vagrant like @autumnblazey mentioned in discord. I've just no clue in writing images to make sure our dev environments are synced up. It's why I went the route of toolbox, since it makes it simple without me having to touch things with writing an image. Totally open to changing that, and would end up with Toolbox under Linux as an option or having Vagrant with some pre-made images based on the person's OS/packaging flavor IMO.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was more meaning this as then to detail instructions of the tool for the different OS's like so. For example:

- Toolbox: ...
  - Linux: Can be set up in most distributions using your package manager or with brew.
  - Mac: Can be setup with Brew, or otherwise setup using the [Official Website]()
  - Windows: ... idk Get rekt or something

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea just gonna close this conversation. This is something we need to discuss and change to other tooling so that people's stuff doesn't break when helping us. Preferably vagrant or something like that (if we can find a universal gui for setting this up…).

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! Put this where you want it and go ahead and change directories to this.
kaosine marked this conversation as resolved.
Show resolved Hide resolved
- Once you've installed toolbox create one using the following `toolbox create pulsar-site` where pulsar-site is the name we're specifying here for this container.
kaosine marked this conversation as resolved.
Show resolved Hide resolved
- Then enter it with `toolbox enter pulsar-site`.
kaosine marked this conversation as resolved.
Show resolved Hide resolved
-