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

Jump to bottom

Link to Knowledge Sharing Sessions #269

Merged
merged 2 commits into from
Oct 3, 2024
Merged

Link to Knowledge Sharing Sessions #269

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb6f973
Add links to knowledge sharing sessions
jafeltra Sep 30, 2024
4e36bcf
Fix recording link
jafeltra Oct 3, 2024
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
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ For more information about the evolving FSH syntax see the [FHIR Shorthand Refer
* Security Information: The GoFSH Security Information can be found in [SECURITY.md](SECURITY.md).
* Compliance Information: GoFSH supports importing FHIR R4, FHIR R4B, and FHIR R5 artifacts. GoFSH assumes valid FHIR inputs. If invalid FHIR artifacts are provided as input, GoFSH may report errors and/or create invalid FSH. The GoFSH source code includes a comprehensive suite of unit tests to test GoFSH's own behavior and compliance with FHIR, which can be found in the [test](test) directory.

# Installation for GoFSH Users
# GoFSH User Instructions

## Installation for GoFSH Users

GoFSH requires [Node.js](https://nodejs.org/) to be installed on the user's system. Users should install Node.js 18. Although previous versions of Node.js may work, they are not officially supported.

Expand Down Expand Up @@ -49,7 +51,14 @@ Options:
-h, --help display help for command
```

# Installation for Developers
# GoFSH Developer Instructions

## Intro to GoFSH Development

To learn more about GoFSH, watch the Knowledge Sharing Sessions for [Developing FSH Tools](https://vimeo.com/990594228/056b5c075f) (view the slides [here](https://confluence.hl7.org/display/FHIR/FSH+Knowledge+Sharing+Sessions?preview=/256509612/256514908/KSS%203%20-%20Developing%20FSH%20Tools.pdf)) and [Developing GoFSH](https://vimeo.com/1001309480/f2b262aee7) (view the slides [here](https://confluence.hl7.org/display/FHIR/FSH+Knowledge+Sharing+Sessions?preview=/256509612/265487253/KSS%205%20-%20Developing%20GoFSH.pdf)).
These sessions provide a technical overview of the codebase and summarize key concepts for developers.

## Installation for Developers

GoFSH is a [TypeScript](https://www.typescriptlang.org/) project. At a minimum, GoFSH requires [Node.js](https://nodejs.org/) to build, test, and run the CLI. Developers should install Node.js 18. Although previous versions of Node.js may work, they are not officially supported.

Expand All @@ -59,7 +68,7 @@ Once Node.js is installed, run the following command from this project's root fo
$ npm install
```

# NPM tasks
## NPM tasks

The following NPM tasks are useful in development:

Expand All @@ -83,7 +92,7 @@ To run any of these tasks, use `npm run`. For example:
$ npm run check
```

# Recommended Development Environment
## Recommended Development Environment

For the best experience, developers should use [Visual Studio Code](https://code.visualstudio.com/) with the following plugins:

Expand Down
Loading