Skip to content

Readme improvements #435

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.

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

Closed
adorton-adobe opened this issue Jan 8, 2019 · 2 comments
Closed

Readme improvements #435

adorton-adobe opened this issue Jan 8, 2019 · 2 comments
Assignees
Milestone

Comments

@adorton-adobe
Copy link
Collaborator

The readme could use some love. Here are a few quick ideas. I'll add more if I think of any.

  • Make the intro paragraph more concise
  • Link to the UST installer tools
  • Move build instructions to user manual appendix (and link to it from readme)
@adorton-adobe adorton-adobe added this to the v2.4 milestone Jan 8, 2019
@adorton-adobe adorton-adobe self-assigned this Jan 8, 2019
@adorton-adobe
Copy link
Collaborator Author

The Windows build instructions could use some improvement.

  • Cygwin isn't necessary or recommended to build the Sync Tool in Windows. make can easily be installed with Chocolatey (choco install make). GNU Make for Windows also works just fine.
  • Git should be installed from Git for Windows - https://git-scm.com/download/win
  • I've never had to install any C++ libraries to get a Python 3 virtual environment working
  • We now ship the required win64 builds for python-ldap in the external directory. This requirement should go away once we switch to ldap3 (see Switch to ldap3 #436).

The upcoming Appveyor build scripts will provide a template for a sane set of build instructions that will work.

@adorton-adobe adorton-adobe modified the milestones: v2.4, v2.4.1 Jan 24, 2019
@adorton-adobe adorton-adobe modified the milestones: v2.4.1, v2.5 Mar 1, 2019
@adorton-adobe adorton-adobe removed this from the v2.5.0 milestone May 30, 2019
@adorton-adobe adorton-adobe added this to the v2.6.0 milestone Mar 26, 2020
@adorton-adobe
Copy link
Collaborator Author

Updates are complete

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant