Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sam-the-programmer authored Jun 24, 2024
1 parent ec2b76b commit d1d90e4
Showing 1 changed file with 29 additions and 28 deletions.
57 changes: 29 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,44 +7,22 @@
</section>

- [🏰 SandCastle](#--sandcastle)
- [Usage](#usage)
- [Arguments](#arguments)
- [_castle.yaml_](#castleyaml)
- [Installation](#installation)
- [Binaries](#binaries)
- [Windows](#windows)
- [Linux](#linux)
- [MacOS](#macos)
- [From Source](#from-source)
- [Usage](#usage)
- [Arguments](#arguments)
- [_castle.yaml_](#castleyaml)
- [Recognised Shells](#recognised-shells)

# Installation

## Binaries

### Windows

- Download the `castle.exe` binary from [releases page](https://github.com/sam-the-programmer/sandcastle/releases/latest).
- Add it to your `$PATH` and you're good to go!

### Linux

- Download the `castle` binary from [releases page](https://github.com/sam-the-programmer/sandcastle/releases/latest).
- Add it to your `$PATH` and you're good to go!

### MacOS

- Download the `castle-macos` binary from [releases page](https://github.com/sam-the-programmer/sandcastle/releases/latest).
- Rename it to `castle`
- Add it to your `$PATH` and you're good to go!

## From Source
- [Recognised Shells](#recognised-shells)

# Usage

## Arguments

- `init` initialise a **SandCastle** project.
<!-- - `init` initialise a **SandCastle** project. -->
- `<task-name>` run the specified task.

## _castle.yaml_
Expand Down Expand Up @@ -72,7 +50,30 @@ tasks: # the tasks, use the name of the task as a CLI argument
Now, if we wanted to run the `deploy` task, we would run `castle deploy`. Just like that!

## Recognised Shells
# Installation

## Binaries

### Windows

- Download the `castle.exe` binary from [releases page](https://github.com/sam-the-programmer/sandcastle/releases/latest).
- Add it to your `$PATH` and you're good to go!

### Linux

- Download the `castle` binary from [releases page](https://github.com/sam-the-programmer/sandcastle/releases/latest).
- Add it to your `$PATH` and you're good to go!

### MacOS

- Download the `castle-macos` binary from [releases page](https://github.com/sam-the-programmer/sandcastle/releases/latest).
- Rename it to `castle`
- Add it to your `$PATH` and you're good to go!

## From Source
Clone the repo and run **"go build"**. To run with a demo file, run **"castle run"** using SandCastle itself.

# Recognised Shells

In order to run shell commands, you need to have a shell installed. **SandCastle** supports the following shells:

Expand Down

0 comments on commit d1d90e4

Please sign in to comment.