Skip to content
Merged
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
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,14 @@ Unix tools:
* [Watchman] for watching for filesystem events
* [Zsh] as your shell
* [rlwrap] readline wrapper
* [pandoc] markup converter (also used under the hood by Quarto)
* [tree] lists contents of directory in a tree like structure
* [jq] JSON parser
* [yq] YAML/XML processor, same idea as jq -- used on `project-registry.yaml`, Carpentries lesson `config.yaml`, and GitHub workflow files
* [wget] network downloader
* [rclone] cloud storage data synch
* [git-lfs] Git support for large data files
* [xan] fast CSV toolkit for data work
* [docker] container runtime (Docker Desktop, includes CLI + GUI)

[Universal Ctags]: https://ctags.io/
Expand All @@ -107,10 +111,14 @@ Unix tools:
[Tmux]: http://tmux.github.io/
[Watchman]: https://facebook.github.io/watchman/
[rlwrap]: https://linux.die.net/man/1/rlwrap
[pandoc]: https://pandoc.org
[tree]: https://linux.die.net/man/1/tree
[jq]: https://stedolan.github.io/jq/
[yq]: https://github.com/mikefarah/yq
[wget]: https://www.geeksforgeeks.org/wget-command-in-linux-unix/
[rclone]: https://rclone.org
[git-lfs]: https://git-lfs.com/
[xan]: https://github.com/medialab/xan
[docker]: https://www.docker.com/products/docker-desktop/

* [GitHub CLI] for interacting with the GitHub API
Expand All @@ -137,6 +145,13 @@ Languages and editors:
[Node.js]: https://nodejs.org/
[Quarto]: https://quarto.org/

Linting / repo maintenance:

* [ShellCheck] for shell script linting (used on `mac` itself, see Contributing below)
* [yamllint] for YAML linting

[yamllint]: https://yamllint.readthedocs.io/

It should take less than 15 minutes to install (depends on your machine).

See the [wiki](https://github.com/UCLA-DataSquad/laptop/wiki)
Expand All @@ -147,10 +162,10 @@ Contributing

1. Edit the `mac` file.
2. Document in the `README.md` file.
3. Follow shell style guidelines by using [ShellCheck] and [Syntastic].
3. Follow shell style guidelines by using [ShellCheck] and [Syntastic]. `shellcheck` is installed by `mac` itself (see above), so if you've already run the script once you have it:

```sh
brew install shellcheck
shellcheck -s sh mac
```

[ShellCheck]: http://www.shellcheck.net/about.html
Expand Down
12 changes: 11 additions & 1 deletion mac
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,14 @@ brew "xz"
brew "libxt"
brew "cairo"
brew "rlwrap"
#brew "pandoc"
brew "pandoc"
brew "tree"
brew "jq"
brew "yq"
brew "wget"
brew "rclone"
brew "git-lfs"
brew "xan"

# GitHub
brew "gh"
Expand All @@ -119,6 +122,10 @@ brew "imagemagick"
brew "libyaml" # should come after openssl
brew "coreutils"

# Linting / repo maintenance
brew "shellcheck"
brew "yamllint"

#Programming languages
brew "r"
brew "node" # provides node + npm; Astro/Jekyll/Hugo site tooling is scaffolded per-project via npm/bundler, not installed globally
Expand Down Expand Up @@ -146,6 +153,9 @@ fancy_echo "Setting up Miniforge conda ..."
conda init "$(basename "${SHELL}")"
conda update -y conda

fancy_echo "Setting up git-lfs ..."
git lfs install

# uncomment if you want to create and run your own local additions to this script
#if [ -f ".laptop.local" ]; then
# fancy_echo "Running your customizations from ~/.laptop.local ..."
Expand Down
Loading