Skip to content

Commit

Permalink
Documentation updates for release 0.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jfredenburg committed Jan 15, 2024
1 parent abb5dcf commit 9af42e2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 14 deletions.
22 changes: 10 additions & 12 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Security
```

## [Unreleased] - YYYY-MM-DD
## [0.4.0] - 2023-01-04
### Added
- Configurations cannow share a common Makefile by allowing for configuration specific hooks to be
created for the `check`, `install`, `test`, and `uninstall` targets.
### Changedq
- Cleaned up the linux-server `.bashrc` and enabled use overrides with a `.bashrc_local` file.
- Refactored config specific Makefiles to share config settings with caller and to search for
config files under src instead of listing them
- Defauly installation path moved to `~/.local/lib/fnal-asic-compute-shared`.
- Renamed `make/shared-targets.mk` -> `make/private-targets.mk`
- Configurations can now share a common Makefile which allows for configuration specific
customizations to added using hook targets: `hook-check`, `hook-install`, `hook-test`, and
`hook-uninstall`.
### Changed
- Simplified Makefile into a barebones file that only provides a list of targets
- Cleaned up the linux-server `.bashrc` and enabled overrides and customizaitons through a
`.bashrc_local` file.
- Default installation path moved to `~/.local/lib/fnal-asic-compute-shared`.
- Renamed `make/shared-targets.mk` -> `make/private.mk`
- Renamed `fnal-asic-config-macos` -> `fnal-asic-config-macos-client`
- Renamed `fnal-asic-config-linux` -> `fnal-asic-config-linux-server`
### Deprecated
### Fixed
- Minor formating and type fixes to macos-client `.zshrc` file.
- All Makefile targets inherit the primary `WORKDIR_ROOT` value.
### Security


## [0.3.1] - 2023-01-10
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ The Linux server configuration provides the following user configuation files:
The user configuration files can installed using the code snippet below.

```bash
curl -sL https://github.com/ic-designer/fnal-asic-compute/archive/refs/tags/0.3.1.tar.gz | tar xz
make -C fnal-asic-compute-0.3.1 install
curl -sL https://github.com/ic-designer/fnal-asic-compute/archive/refs/tags/0.4.0.tar.gz | tar xz
make -C fnal-asic-compute-0.4.0 install
```

The Makefile will use information about the operating system to determine which configuration to
Expand Down

0 comments on commit 9af42e2

Please sign in to comment.