Skip to content

Commit 7d9e130

Browse files
author
Roderik van der Veer
committed
Add a readme file
1 parent c339112 commit 7d9e130

File tree

1 file changed

+12
-27
lines changed

1 file changed

+12
-27
lines changed

README.md

Lines changed: 12 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,23 @@
1-
Role Name
2-
=========
1+
# computername
32

4-
A brief description of the role goes here.
3+
Ansible role to set the computer name on OSX. This role is part of the Superlumic project that aims to simplify repeat computer setups on OSX, 10.10 and up.
54

6-
Requirements
7-
------------
5+
## Requirements
86

9-
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
7+
* OSX 10.10 or 10.11
108

11-
Role Variables
12-
--------------
9+
## Dependencies
1310

14-
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
11+
* [osx-defaults](https://github.com/superlumic/ansible-role-osx-defaults)
1512

16-
Dependencies
17-
------------
13+
# Usage
1814

19-
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
15+
Check [Superlumic](https://github.com/superlumic/superlumic) for documentation
2016

21-
Example Playbook
22-
----------------
17+
# License
2318

24-
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
19+
MIT
2520

26-
- hosts: servers
27-
roles:
28-
- { role: username.rolename, x: 42 }
21+
# Author
2922

30-
License
31-
-------
32-
33-
BSD
34-
35-
Author Information
36-
------------------
37-
38-
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
23+
[Roderik van der Veer](mailto:roderik@superlumic.com) - [@r0derik](https://twitter.com/r0derik)

0 commit comments

Comments
 (0)