Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
auto-tx
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
vamp
auto-tx
Commits
ba77e4fd
Commit
ba77e4fd
authored
7 years ago
by
Niko Ehrenfeuchter
Browse files
Options
Downloads
Patches
Plain Diff
Move "Development" section to CONTRIBUTING.md
parent
3f34ad4c
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
CONTRIBUTING.md
+52
-0
52 additions, 0 deletions
CONTRIBUTING.md
README.md
+3
-49
3 additions, 49 deletions
README.md
with
55 additions
and
49 deletions
CONTRIBUTING.md
0 → 100644
+
52
−
0
View file @
ba77e4fd
# AutoTx Development And Contribution Guide
## Code Structure
The code has evolved from a very basic project, initially all being a
monolithic structure where the major part of the functionality is contained in
one central class. This is certainly not the most elegant design, but it was
getting the job done. A lot of refactoring has been done with the project
currently being split into a few separate parts:
-
[
ATxCommon
](
ATxCommon
)
: all the common components like configuration and
status serialization wrappers, unit converters, file system tasks and so on
bundled as a runtime library.
-
[
ATxService
](
ATxService
)
: the core service functionality.
-
[
ATxConfigTest
](
ATxConfigTest
)
: a small command line tool allowing to validate
a given configuration file and show a summary. Used in the updater to ensure
new configurations are valid before overwriting existing ones.
-
[
ATxTray
](
ATxTray
)
: the tray application.
-
[
Updater
](
Updater
)
: the updater script for binaries and configuration files.
Refactoring suggestions and / or pull requests are welcome!
## Prerequisites
-
**VisualStudio 2017**
- the
*Community Edition*
is sufficient.
-
**ReSharper**
- JetBrains ReSharper Ultimate 2017.1 has been used for
development. Respecting the
*Coding Style*
will be very difficult without it,
not speaking of the other features you might miss. So basically this is a
must...
-
For having the assembly details automatically filled with version details at
build-time, a working installation of
**Git**
and
**PowerShell**
is required.
-
To build the C# bindings for RoboCopy, it is now fine to use the sources from
the
[
original repository on github
][
web_robosharp
]
. To benefit from
automatically filling assembly details during the build you can use our fork
provided here:
[
RoboSharp fork
][
web_robosharp_fork
]
.
## Building + Installing
-
Open the solution file in
*Visual Studio*
and adjust the path to the
*RoboSharp*
DLL under
*Solution Explorer*
>
*ATxService*
>
*References*
. Then
simply build all components by pressing
*F6*
or by selecting
*Build Solution*
from the
*Build*
menu.
-
After building the service, use the
[
Make-Package.ps1
](
AutoTx/Resources/Make-Package.ps1
)
script to create an
installation package. It will contain the previously mentioned
[
Install-Service.ps1
](
AutoTx/Resources/Install-Service.ps1
)
script, the latest
configuration file version and of course the required service binaries, DLLs,
etc.
[
web_robosharp
]:
https://github.com/tjscience/RoboSharp
[
web_robosharp_fork
]:
https://git.scicore.unibas.ch/vamp/robosharp
\ No newline at end of file
This diff is collapsed.
Click to expand it.
README.md
+
3
−
49
View file @
ba77e4fd
...
...
@@ -183,56 +183,10 @@ The service comes with a dedicated updater to facilitate managing updates and
configurations on many machines. See the
[
Updater Readme
](
Updater/README.md
)
for
all the details.
# Contributing
# Development
## Code Structure
The code has evolved from a very basic project, initially all being a
monolithic structure where the major part of the functionality is contained in
one central class. This is certainly not the most elegant design, but it was
getting the job done. A lot of refactoring has been done with the project
currently being split into a few separate parts:
-
[
ATxCommon
](
ATxCommon
)
: all the common components like configuration and
status serialization wrappers, unit converters, file system tasks and so on
bundled as a runtime library.
-
[
ATxService
](
ATxService
)
: the core service functionality.
-
[
ATxConfigTest
](
ATxConfigTest
)
: a small command line tool allowing to validate
a given configuration file and show a summary. Used in the updater to ensure
new configurations are valid before overwriting existing ones.
-
[
ATxTray
](
ATxTray
)
: the tray application.
-
[
Updater
](
Updater
)
: the updater script for binaries and configuration files.
Refactoring suggestions and / or pull requests are welcome!
## Prerequisites
-
**VisualStudio 2017**
- the
*Community Edition*
is sufficient.
-
**ReSharper**
- JetBrains ReSharper Ultimate 2017.1 has been used for
development. Respecting the
*Coding Style*
will be very difficult without it,
not speaking of the other features you might miss. So basically this is a
must...
-
For having the assembly details automatically filled with version details at
build-time, a working installation of
**Git**
and
**PowerShell**
is required.
-
To build the C# bindings for RoboCopy, it is now fine to use the sources from
the
[
original repository on github
][
web_robosharp
]
. To benefit from
automatically filling assembly details during the build you can use our fork
provided here:
[
RoboSharp fork
][
web_robosharp_fork
]
.
## Building + Installing
-
Open the solution file in
*Visual Studio*
and adjust the path to the
*RoboSharp*
DLL under
*Solution Explorer*
>
*ATxService*
>
*References*
. Then
simply build all components by pressing
*F6*
or by selecting
*Build Solution*
from the
*Build*
menu.
-
After building the service, use the
[
Make-Package.ps1
](
AutoTx/Resources/Make-Package.ps1
)
script to create an
installation package. It will contain the previously mentioned
[
Install-Service.ps1
](
AutoTx/Resources/Install-Service.ps1
)
script, the latest
configuration file version and of course the required service binaries, DLLs,
etc.
Please see the
[
Development And Contribution Guide
](
CONTRIBUTING.md
)
for details
about compiling from source, filing pull requests etc.
[
img_autotx_logo
]:
https://git.scicore.unibas.ch/vamp/auto-tx/raw/master/Resources/auto-tx-logo.png
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment