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

Change f2 to be exch instead of # #119

Merged
merged 6 commits into from
Nov 17, 2022
Merged

Change f2 to be exch instead of # #119

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
478f57b
Change F2 from Number/# to Exchange/EXCH
tekenny Nov 10, 2022
d588c11
initial developers onboarding documentation
tekenny Nov 10, 2022
8bca9d1
resize buttons and set F2 label as <exch>
tekenny Nov 11, 2022
2c060ab
remove file from a bad merge
tekenny Nov 11, 2022
2cff8ae
Merge branch 'main' into Change-F2-to-be-EXCH-instead-of-#
tekenny Nov 11, 2022
70cda76
files needed to get started on the project using the Delphi IDE
tekenny Nov 12, 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
42 changes: 42 additions & 0 deletions .github/DEVELOPERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
The purpose of this document is to document the steps for a new developer to this project to get onboarded
to be able to contribute to the project.

1 - The source code for this application is written in the Pascal programming language.
Only Windows operating systems are currently supported as the target platform for the application to run.

1 - Fork the repo to your own GitHub account.

1 - Get your IDE (Integrated Development Environment) setup
This project is currently supported with the use of two seperate IDEs for Pascal
- Lazarus version 2.2.4 (fpc 3.2.2)
Lazarus was the original IDE used for MorseRunner
- Delphi Community Edition (aka RX RAD Studio 10.4)
Delphia CE is free for use by open source projects and Delphi is the perferred IDE at this time
Please not that there are github branches to support each of these IDEs
w7sst marked this conversation as resolved.
Show resolved Hide resolved
### TBD how do you configure each IDE?

1 - Clone your git repo into the IDE

1 - Directory hierarcy
.git - DO NOT TOUCH the contents here is how git does all it's magic
.github - contains support pages
PerlRegEx - TBD
VCL - Visual Component Library who's purpose is TBD
tools - contains verify-normalization.sh script who's purpose is TBD
. - the parent directory of the repo contains the bulk of the source code, configuration and data files
### TBD source directory refactoring. Should we look to put .pas and possibly other files in a src subdirectory?

1 - How to write and contribute unit tests
There aren't any unit tests. This may be added to the roadmap. Code refactoring will be needed to be able to support unit testing.
### TBD add unit testing framework and refactor to support it to the long term roadmap

1 - How to build, run, test the source code

1 - How to build an executable

1 - Production builds are currently created for each release by W7SST
### TBD add automated nightly test builds and versioned release builds to the long term roadmap
### TBD perform builds via github actions? if not then maybe GitLab, Travis or Jenkins?

In conclusion, thank you for volunteering to help improve this project. We all look forward to your contributions!